chore: fix obsolete env vars, health route, model example, and unused ports in Docugen-Microagents docs - #7
Closed
gopal-raj-suresh wants to merge 1 commit into
Closed
Conversation
Collaborator
Author
|
Retargeting to opea-project/Enterprise-Inference (upstream). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The DocuGen Micro-Agents docs referenced variables, routes, and a model that no longer match the shipped code. This aligns them with the current
.env.example,docker-compose.yml, andapi/server.py.Fixes
1. Obsolete auth variables —
TROUBLESHOOTING.md,docs/GENERIC_USAGE.mdreferencedAUTH_MODE,GENAI_GATEWAY_*,KEYCLOAK_*,BASE_URL, none of which exist in.env.example. Replaced withINFERENCE_API_ENDPOINT/INFERENCE_API_TOKEN.2. Health route —
TROUBLESHOOTING.mdusedcurl .../api/health; the actual route (api/server.py) and compose healthcheck use/health. Fixed.3. Model example — README's APISIX URL example used
Llama-3.1-8B-Instruct, contradicting the validated model (Qwen/Qwen3-4B-Instruct-2507) documented elsewhere in the same file. Corrected.4. Unused ports —
BACKEND_PORT/FRONTEND_PORTin.env.exampleare read by nothing; ports are hardcoded to5001/3000indocker-compose.yml,config.py, andvite.config.js. Removed.Also: container names →
Docugen-Microagents-*(matching compose), anddocker-compose→docker compose(v2).Scope
Documentation and
.env.exampleonly — no code changes.